<!DOCTYPE html>

<html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <title>FindJava &mdash; CMake 4.1.1 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css?v=4d06bd55" />
    
    <script src="../_static/documentation_options.js?v=e6a937a4"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    
    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindJNI" href="FindJNI.html" />
    <link rel="prev" title="FindJasper" href="FindJasper.html" />
 

  </head><body>
    <input id="sidebar-check" type="checkbox" />
    <label id="sidebar-overlay" for="sidebar-check"></label>



    <div class="related relbar1" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="FindJNI.html" title="FindJNI"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="FindJasper.html" title="FindJasper"
             accesskey="P">previous</a> |</li>
  <li>
    <label class="sidebar-toggle" for="sidebar-check"></label>
  </li>
  <li class="rootlink">
    <img src="../_static/cmake-logo-16.png" width="16" height="16" alt=""/>
    <a href="https://cmake.org/">CMake 4.1.1</a>
    <span class="reldelim1"> &#187;</span>
  </li>
  <li>
    <a href="../index.html">Documentation</a> &#187;
  </li>

          <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">FindJava</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="findjava">
<span id="module:FindJava"></span><h1>FindJava<a class="headerlink" href="#findjava" title="Link to this heading">¶</a></h1>
<p>Finds the Java installation and determines its runtime tools and development
components.</p>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 3.10: </span>Support for Java 9+ version parsing.</p>
</div>
<section id="components">
<h2>Components<a class="headerlink" href="#components" title="Link to this heading">¶</a></h2>
<p>This module supports the following components:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">Runtime</span></code></dt><dd><p>Finds the Java Runtime Environment used to execute Java byte-compiled
applications.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Development</span></code></dt><dd><p>Finds development tools (<code class="docutils literal notranslate"><span class="pre">java</span></code>, <code class="docutils literal notranslate"><span class="pre">javac</span></code>, <code class="docutils literal notranslate"><span class="pre">javah</span></code>, <code class="docutils literal notranslate"><span class="pre">jar</span></code>, and
<code class="docutils literal notranslate"><span class="pre">javadoc</span></code>).  Specifying this component also implies the <code class="docutils literal notranslate"><span class="pre">Runtime</span></code>
component.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">IdlJ</span></code></dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 3.4.</span></p>
</div>
<p>Finds the Interface Description Language (IDL) to Java compiler.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">JarSigner</span></code></dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 3.4.</span></p>
</div>
<p>Finds the signer and verifier tool for Java Archive (JAR) files.</p>
</dd>
</dl>
<p>Components can optionally be specified using the standard syntax with:</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package(</span><span class="nb">Java</span><span class="w"> </span><span class="p">[</span><span class="no">COMPONENTS</span><span class="w"> </span><span class="nv">&lt;components&gt;...</span><span class="p">]</span><span class="nf">)</span>
</pre></div>
</div>
<p>If no <code class="docutils literal notranslate"><span class="pre">COMPONENTS</span></code> are specified, the module searches for the <code class="docutils literal notranslate"><span class="pre">Runtime</span></code>
component by default.</p>
</section>
<section id="result-variables">
<h2>Result Variables<a class="headerlink" href="#result-variables" title="Link to this heading">¶</a></h2>
<p>This module defines the following variables:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">Java_FOUND</span></code></dt><dd><p>Boolean indicating whether Java with all specified components is found.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_&lt;component&gt;_FOUND</span></code></dt><dd><p>Boolean indicating whether the <code class="docutils literal notranslate"><span class="pre">&lt;component&gt;</span></code> is found.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_VERSION</span></code></dt><dd><p>Version of Java found.  This is set to:
<code class="docutils literal notranslate"><span class="pre">&lt;major&gt;[.&lt;minor&gt;[.&lt;patch&gt;[.&lt;tweak&gt;]]]</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_VERSION_MAJOR</span></code></dt><dd><p>The major version of Java found.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_VERSION_MINOR</span></code></dt><dd><p>The minor version of Java found.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_VERSION_PATCH</span></code></dt><dd><p>The patch version of Java found.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_VERSION_TWEAK</span></code></dt><dd><p>The tweak version of Java found (part after the underscore character <code class="docutils literal notranslate"><span class="pre">_</span></code>).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_VERSION_STRING</span></code></dt><dd><p>Version of Java found, e.g., <code class="docutils literal notranslate"><span class="pre">1.6.0_12</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><code class="docutils literal notranslate"><span class="pre">Java_VERSION</span></code> and <code class="docutils literal notranslate"><span class="pre">Java_VERSION_STRING</span></code> are not guaranteed to be
identical.  For example, some Java versions may return:
<code class="docutils literal notranslate"><span class="pre">Java_VERSION_STRING</span> <span class="pre">=</span> <span class="pre">1.8.0_17</span></code> and <code class="docutils literal notranslate"><span class="pre">Java_VERSION</span> <span class="pre">=</span> <span class="pre">1.8.0.17</span></code>.</p>
<p>Another example is the Java OEM, with <code class="docutils literal notranslate"><span class="pre">Java_VERSION_STRING</span> <span class="pre">=</span> <span class="pre">1.8.0-oem</span></code>
and <code class="docutils literal notranslate"><span class="pre">Java_VERSION</span> <span class="pre">=</span> <span class="pre">1.8.0</span></code>.</p>
</div>
</dd>
</dl>
</section>
<section id="cache-variables">
<h2>Cache Variables<a class="headerlink" href="#cache-variables" title="Link to this heading">¶</a></h2>
<p>The following cache variables may also be set:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">Java_JAVA_EXECUTABLE</span></code></dt><dd><p>The full path to the Java runtime.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_JAVAC_EXECUTABLE</span></code></dt><dd><p>The full path to the Java compiler.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_JAVAH_EXECUTABLE</span></code></dt><dd><p>The full path to the Java header generator.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_JAVADOC_EXECUTABLE</span></code></dt><dd><p>The full path to the Java documentation generator.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_IDLJ_EXECUTABLE</span></code></dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 3.4.</span></p>
</div>
<p>The full path to the Java idl compiler.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_JAR_EXECUTABLE</span></code></dt><dd><p>The full path to the Java archiver.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">Java_JARSIGNER_EXECUTABLE</span></code></dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 3.4.</span></p>
</div>
<p>The full path to the Java jar signer.</p>
</dd>
</dl>
</section>
<section id="hints">
<h2>Hints<a class="headerlink" href="#hints" title="Link to this heading">¶</a></h2>
<p>This module accepts the following variables:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">JAVA_HOME</span></code></dt><dd><p>The caller can set this variable to specify the installation directory of Java
explicitly.</p>
</dd>
</dl>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
<p>Finding Java:</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package(</span><span class="nb">Java</span><span class="nf">)</span>
</pre></div>
</div>
<p>Finding Java with at least the specified minimum version:</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package(</span><span class="nb">Java</span><span class="w"> </span><span class="m">1.8</span><span class="nf">)</span>
</pre></div>
</div>
<p>Finding Java and making it required (if Java is not found, processing stops with
an error message):</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package(</span><span class="nb">Java</span><span class="w"> </span><span class="m">1.8</span><span class="w"> </span><span class="no">REQUIRED</span><span class="nf">)</span>
</pre></div>
</div>
<p>Specifying the needed Java components to find:</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">find_package(</span><span class="nb">Java</span><span class="w"> </span><span class="no">COMPONENTS</span><span class="w"> </span><span class="nb">Development</span><span class="w"> </span><span class="nb">JarSigner</span><span class="nf">)</span>
</pre></div>
</div>
</section>
<section id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>The <span class="target" id="index-0-module:FindJNI"></span><a class="reference internal" href="FindJNI.html#module:FindJNI" title="FindJNI"><code class="xref cmake cmake-module docutils literal notranslate"><span class="pre">FindJNI</span></code></a> module to find Java Native Interface (JNI).</p></li>
<li><p>The <span class="target" id="index-0-module:UseJava"></span><a class="reference internal" href="UseJava.html#module:UseJava" title="UseJava"><code class="xref cmake cmake-module docutils literal notranslate"><span class="pre">UseJava</span></code></a> module to use Java in CMake.</p></li>
</ul>
</section>
</section>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
  <div>
    <h3>Table of Contents</h3>
    <ul>
<li><a class="reference internal" href="#">FindJava</a><ul>
<li><a class="reference internal" href="#components">Components</a></li>
<li><a class="reference internal" href="#result-variables">Result Variables</a></li>
<li><a class="reference internal" href="#cache-variables">Cache Variables</a></li>
<li><a class="reference internal" href="#hints">Hints</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
</ul>

  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="FindJasper.html"
                          title="previous chapter">FindJasper</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="FindJNI.html"
                          title="next chapter">FindJNI</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/module/FindJava.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="FindJNI.html" title="FindJNI"
             >next</a> |</li>
        <li class="right" >
          <a href="FindJasper.html" title="FindJasper"
             >previous</a> |</li>
  <li>
    <label class="sidebar-toggle" for="sidebar-check"></label>
  </li>
  <li class="rootlink">
    <img src="../_static/cmake-logo-16.png" width="16" height="16" alt=""/>
    <a href="https://cmake.org/">CMake 4.1.1</a>
    <span class="reldelim1"> &#187;</span>
  </li>
  <li>
    <a href="../index.html">Documentation</a> &#187;
  </li>

          <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">FindJava</a></li> 
      </ul>
    </div>

    <div class="footer" role="contentinfo">
    &#169; Copyright 2000-2025 Kitware, Inc. and Contributors.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
<script type="text/javascript">
(function() {
  "use strict";
  const hide = () => document.getElementById("sidebar-check").checked = false;
  addEventListener("keydown", e => (e.key === "Escape") && hide());
  addEventListener("click", e => (e.target.tagName === "A") && hide());
  addEventListener("hashchange", hide)
})();
</script>
  </body>
</html>